IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/SCSL/saxpy.z/saxpy

Text File | 2002-10-03 | 15.3 KB | 331 lines

SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))                                                            SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))



NNNNAAAAMMMMEEEE
     SSSSAAAAXXXXPPPPYYYY, CCCCAAAAXXXXPPPPYYYY, DDDDAAAAXXXXPPPPYYYY, ZZZZAAAAXXXXPPPPYYYY - Adds a scalar multiple of a real or complex
     vector to another real or complex vector

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     Single precision

          Fortran:
               CCCCAAAALLLLLLLL SSSSAAAAXXXXPPPPYYYY ((((_n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               vvvvooooiiiidddd ssssaaaaxxxxppppyyyy(((( iiiinnnntttt _n,,,, ffffllllooooaaaatttt _a_l_p_h_a,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x,,,, ffffllllooooaaaatttt *_y,,,,
               iiiinnnntttt _i_n_c_y ))));;;;

     Double precision

          Fortran:
               CCCCAAAALLLLLLLL DDDDAAAAXXXXPPPPYYYY ((((_n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               vvvvooooiiiidddd ddddaaaaxxxxppppyyyy(((( iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee _a_l_p_h_a,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x,,,, ddddoooouuuubbbblllleeee
               *_y,,,, iiiinnnntttt _i_n_c_y ))));;;;

     Single precision complex

          Fortran:
               CCCCAAAALLLLLLLL CCCCAAAAXXXXPPPPYYYY ((((_n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               vvvvooooiiiidddd ccccaaaaxxxxppppyyyy(((( iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt
               _i_n_c_x,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y ))));;;;

          C++ STL:
               ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               vvvvooooiiiidddd ccccaaaaxxxxppppyyyy(((( iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_l_p_h_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,iiiinnnntttt
               _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_y,,,, iiiinnnntttt _i_n_c_y ))));;;;

     Double precision complex

          Fortran:

               CCCCAAAALLLLLLLL ZZZZAAAAXXXXPPPPYYYY ((((_n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               vvvvooooiiiidddd zzzzaaaaxxxxppppyyyy(((( iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt
               _i_n_c_x,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y ))));;;;




                                                                        PPPPaaaaggggeeee 1111






SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))                                                            SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))



          C++ STL:
               ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               vvvvooooiiiidddd zzzzaaaaxxxxppppyyyy(((( iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a_l_p_h_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,,
               iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_y,,,, iiiinnnntttt _i_n_c_y ))));;;;

IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
     These routines are part of the SCSL Scientific Library and can be loaded
     using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
     directs the linker to use the multi-processor version of the library.

     When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
     4 bytes (32 bits). Another version of SCSL is available in which integers
     are 8 bytes (64 bits).  This version allows the user access to larger
     memory sizes and helps when porting legacy Cray codes.  It can be loaded
     by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
     only one of the two versions; 4-byte integer and 8-byte integer library
     calls cannot be mixed.

     The C and C++ prototypes shown above are appropriate for the 4-byte
     integer version of SCSL. When using the 8-byte integer version, the
     variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
     file should be included.

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     SSSSAAAAXXXXPPPPYYYY/DDDDAAAAXXXXPPPPYYYY adds a scalar multiple of a real vector to another real
     vector.

     CCCCAAAAXXXXPPPPYYYY/ZZZZAAAAXXXXPPPPYYYY adds a scalar multiple of a complex vector to another complex
     vector.

     These routines perform the following vector operation:

          _y <-  _a_l_p_h_a * _x + _y

     where _a_l_p_h_a is a real or complex scalar, and _x and _y are real or complex
     vectors.

     See the NOTES section of this man page for information about the
     interpretation of the data types described in the following arguments.

     These routines have the following arguments:

     _n         Integer.  (input)
               Number of elements in the vectors.  If _n <= 0, these routines
               return without any computation.

     _a_l_p_h_a     Scalar. (input)
               SSSSAAAAXXXXPPPPYYYY: Single precision.
               DDDDAAAAXXXXPPPPYYYY: Double precision.
               CCCCAAAAXXXXPPPPYYYY: Single precision complex.
               ZZZZAAAAXXXXPPPPYYYY: Double precision complex.



                                                                        PPPPaaaaggggeeee 2222






SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))                                                            SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))



               If _a_l_p_h_a = 0 these routines return without any computation.

               For C/C++, a pointer to this scalar is passed when alpha is
               complex; otherwise, alpha is passed by value.

     _x         Array of dimension (_n-1) * |_i_n_c_x| + 1.  (input)
               SSSSAAAAXXXXPPPPYYYY: Single precision array.
               DDDDAAAAXXXXPPPPYYYY: Double precision array.
               CCCCAAAAXXXXPPPPYYYY: Single precision complex array.
               ZZZZAAAAXXXXPPPPYYYY: Double precision complex array.
               Contains the vector to be scaled before summation.

     _i_n_c_x      Integer.  (input)
               Increment between elements of _x.  If _i_n_c_x = 0, the results will
               be unpredictable.

     _y         Array of dimension (_n-1) * |_i_n_c_y| + 1.  (input and output)
               SSSSAAAAXXXXPPPPYYYY: Single precision array.
               DDDDAAAAXXXXPPPPYYYY: Double precision array.
               CCCCAAAAXXXXPPPPYYYY: Single precision complex array.
               ZZZZAAAAXXXXPPPPYYYY: Double precision complex array.
               Before calling the routine, _y contains the vector to be summed.
               After the routine ends, _y contains the result of the summation.

     _i_n_c_y      Integer.  (input)
               Increment between elements of _y.  If _i_n_c_y = 0, the results will
               be unpredictable.

NNNNOOOOTTTTEEEESSSS
     These routines are Level 1 Basic Linear Algebra Subprograms (Level 1
     BLAS).

     When working backward (_i_n_c_x < 0 or _i_n_c_y < 0), each routine starts at the
     end of the vector and moves backward, as follows:

          _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)

          _y(1-_i_n_c_y * (_n-1)), _y(1-_i_n_c_y * (_n-2)), ..., _y(1)

   DDDDaaaattttaaaa TTTTyyyyppppeeeessss
     The following data types are described in this documentation:

          TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee

     Fortran:

          Array dimensioned _n           xxxx((((nnnn))))

          Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR






                                                                        PPPPaaaaggggeeee 3333






SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))                                                            SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))



          Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])

          Single precision              RRRREEEEAAAALLLL

          Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN

          Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX

          Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX

     C/C++:

          Array dimensioned _n           xxxx[[[[_n]]]]

          Character                     cccchhhhaaaarrrr

          Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])

          Single precision              ffffllllooooaaaatttt

          Double precision              ddddoooouuuubbbblllleeee

          Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx

          Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx

     C++ STL:

          Array dimensioned _n           xxxx[[[[_n]]]]

          Character                     cccchhhhaaaarrrr

          Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])

          Single precision              ffffllllooooaaaatttt

          Double precision              ddddoooouuuubbbblllleeee

          Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>

          Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>

RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
     When _n <= 0, real _a_l_p_h_a = 0., or complex _a_l_p_h_a = 0 = 0.+0._i, these
     routines return immediately with no change in their arguments.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS1111(3S)

     IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
     Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
     Linear Algebra Subprograms Technical Forum.



                                                                        PPPPaaaaggggeeee 4444






SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))                                                            SSSSAAAAXXXXPPPPYYYY((((3333SSSS))))























































                                                                        PPPPaaaaggggeeee 5555